juce/source/extras/the jucer/src/model/components/jucer_GenericComponentHandler.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_GENERICCOMPONENTHANDLER_JUCEHEADER__
  27 #define __JUCER_GENERICCOMPONENTHANDLER_JUCEHEADER__
  28
  29
  30 //==============================================================================
  31 /**
  32 */
  33 class GenericComponent  : public Component
  34 {
  35 public:
  36     GenericComponent()
  37         : Component ("new component"),
  38           actualClassName ("Component")
  39     {
  40     }
  41
  42     void paint (Graphics& g)
  43     {
  44         g.fillAll (Colours::white.withAlpha (0.25f));
  45
  46         g.setColour (Colours::black.withAlpha (0.5f));
  47         g.drawRect (0, 0, getWidth(), getHeight());
  48         g.drawLine (0.0f, 0.0f, (float) getWidth(), (float) getHeight());
  49         g.drawLine (0.0f, (float) getHeight(), (float) getWidth(), 0.0f);
  50
  51         g.setFont (14.0f);
  52         g.drawText (actualClassName, 0, 0, getWidth(), getHeight() / 2, Justification::centred, true);
  53     }
  54
  55     void setClassName (const String& newName)
  56     {
  57         if (actualClassName != newName)
  58         {
  59             actualClassName = newName;
  60             repaint();
  61         }
  62     }
  63
  64     void setParams (const String& newParams)
  65     {
  66         if (constructorParams != newParams)
  67         {
  68             constructorParams = newParams;
  69             repaint();
  70         }
  71     }
  72
  73     String actualClassName, constructorParams;
  74 };
  75
  76 //==============================================================================
  77 /**
  78 */
  79 class GenericComponentHandler  : public ComponentTypeHandler
  80 {
  81 public:
  82     //==============================================================================
  83     GenericComponentHandler()
  84         : ComponentTypeHandler ("Generic Component", "GenericComponent", typeid (GenericComponent), 150, 24)
  85     {}
  86
  87     //==============================================================================
  88     Component* createNewComponent (JucerDocument*)
  89     {
  90         return new GenericComponent();
  91     }
  92
  93     XmlElement* createXmlFor (Component* comp, const ComponentLayout* layout)
  94     {
  95         XmlElement* e = ComponentTypeHandler::createXmlFor (comp, layout);
  96         e->setAttribute ("class", ((GenericComponent*) comp)->actualClassName);
  97         e->setAttribute ("params", ((GenericComponent*) comp)->constructorParams);
  98
  99         return e;
 100     }
 101
 102     bool restoreFromXml (const XmlElement& xml, Component* comp, const ComponentLayout* layout)
 103     {
 104         if (! ComponentTypeHandler::restoreFromXml (xml, comp, layout))
 105             return false;
 106
 107         ((GenericComponent*) comp)->actualClassName = xml.getStringAttribute ("class", "Component");
 108         ((GenericComponent*) comp)->constructorParams = xml.getStringAttribute ("params", String::empty);
 109         return true;
 110     }
 111
 112     void getEditableProperties (Component* component, JucerDocument& document, Array <PropertyComponent*>& properties)
 113     {
 114         ComponentTypeHandler::getEditableProperties (component, document, properties);
 115
 116         properties.add (new GenericCompClassProperty (dynamic_cast <GenericComponent*> (component), document));
 117         properties.add (new GenericCompParamsProperty (dynamic_cast <GenericComponent*> (component), document));
 118     }
 119
 120     const String getClassName (Component* comp) const
 121     {
 122         return ((GenericComponent*) comp)->actualClassName;
 123     }
 124
 125     const String getCreationParameters (Component* comp)
 126     {
 127         return ((GenericComponent*) comp)->constructorParams;
 128     }
 129
 130     void fillInCreationCode (GeneratedCode& code, Component* component, const String& memberVariableName)
 131     {
 132         ComponentTypeHandler::fillInCreationCode (code, component, memberVariableName);
 133
 134         if (component->getName().isNotEmpty())
 135             code.constructorCode
 136                 << memberVariableName << "->setName ("
 137                 << quotedString (component->getName())
 138                 << ");\n\n";
 139         else
 140             code.constructorCode << "\n";
 141     }
 142
 143 private:
 144     class GenericCompClassProperty  : public ComponentTextProperty <GenericComponent>
 145     {
 146     public:
 147         GenericCompClassProperty (GenericComponent* comp, JucerDocument& document)
 148             : ComponentTextProperty <GenericComponent> ("class", 300, false, comp, document)
 149         {
 150         }
 151
 152         void setText (const String& newText)
 153         {
 154             document.perform (new GenericCompClassChangeAction (component, *document.getComponentLayout(),
 155                                                                 makeValidCppIdentifier (newText, false, false, true)),
 156                               "Change generic component class");
 157         }
 158
 159         const String getText() const
 160         {
 161             return component->actualClassName;
 162         }
 163
 164     private:
 165         class GenericCompClassChangeAction  : public ComponentUndoableAction <GenericComponent>
 166         {
 167         public:
 168             GenericCompClassChangeAction (GenericComponent* const comp, ComponentLayout& layout, const String& newState_)
 169                 : ComponentUndoableAction <GenericComponent> (comp, layout),
 170                   newState (newState_)
 171             {
 172                 oldState = comp->actualClassName;
 173             }
 174
 175             bool perform()
 176             {
 177                 showCorrectTab();
 178                 getComponent()->setClassName (newState);
 179                 changed();
 180                 return true;
 181             }
 182
 183             bool undo()
 184             {
 185                 showCorrectTab();
 186                 getComponent()->setClassName (oldState);
 187                 changed();
 188                 return true;
 189             }
 190
 191             String newState, oldState;
 192         };
 193     };
 194
 195     class GenericCompParamsProperty  : public ComponentTextProperty <GenericComponent>
 196     {
 197     public:
 198         GenericCompParamsProperty (GenericComponent* comp, JucerDocument& document)
 199             : ComponentTextProperty <GenericComponent> ("constructor params", 1024, true, comp, document)
 200         {
 201         }
 202
 203         void setText (const String& newText)
 204         {
 205             document.perform (new GenericCompParamsChangeAction (component, *document.getComponentLayout(), newText),
 206                               "Change generic component class");
 207         }
 208
 209         const String getText() const
 210         {
 211             return component->constructorParams;
 212         }
 213
 214     private:
 215         class GenericCompParamsChangeAction  : public ComponentUndoableAction <GenericComponent>
 216         {
 217         public:
 218             GenericCompParamsChangeAction (GenericComponent* const comp, ComponentLayout& layout, const String& newState_)
 219                 : ComponentUndoableAction <GenericComponent> (comp, layout),
 220                   newState (newState_)
 221             {
 222                 oldState = comp->constructorParams;
 223             }
 224
 225             bool perform()
 226             {
 227                 showCorrectTab();
 228                 getComponent()->setParams (newState);
 229                 changed();
 230                 return true;
 231             }
 232
 233             bool undo()
 234             {
 235                 showCorrectTab();
 236                 getComponent()->setParams (oldState);
 237                 changed();
 238                 return true;
 239             }
 240
 241             String newState, oldState;
 242         };
 243     };
 244 };
 245
 246
 247 #endif   // __JUCER_GENERICCOMPONENTHANDLER_JUCEHEADER__